Basic line/gaussian fit tutorial using breads#58
Merged
Conversation
mperrin
reviewed
Jan 22, 2026
mperrin
left a comment
Collaborator
There was a problem hiding this comment.
As suggested in the call, I think we should relocate this into the docs folder
- Move file to
docs/source/tutorials/ - Edit text file
docs/source/tutorials.rstto include a link to this file.
Some other small suggestions
- Typo "guassian" in the first top header ;-)
- Add a succinct high-level summary paragraph at the start of the page. "This tutorial will teach you how to [big picture idea in a couple sentences]"
- There are a couple places where it looks like entire paragraphs are formatted as headers. Is that intentional? e.g. the entire paragraph shows up bold as a header for "First, we need to define the function for a line. Since the function for a line only contains linear parameters, no non-linear parameters are included. However, the fitfm function requires non-linear parameters, so we must include them in the definition of our line."
- It looks like you have a top-level header with one
#, then a bunch of third-level headers with###, but no second-level headers? Consider if it would help to add some intermediate headers, for instance## Fitting a model with only linear parametersand## Fitting a model also with nonlinear parameters
Owner
|
Check on this Katelyn, what is the current status? |
Fixed typo, added high level paragraph, re-formatted, added breads instrument class, added MCMC simulations
jruffio
force-pushed
the
simple_fitting_dev
branch
from
April 24, 2026 17:09
99afac3 to
ff3cbde
Compare
…Little bit of refactoring too.
Owner
|
The maths examples look great Katelyn. FYI, the error message above was simply because the Simbad server was down. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This notebook has examples of how to create and use forward model functions compatible with breads based on the example data (line or gaussian)